Command
Summary
Command Line Interface (CLI) is used to configure the system
via Telnet. To enter the CLI
you must Telnet into the modem at the modem’s Management IP address
(default 192.168.1.1). The default
username is root. The default password is 12345.
All the system commands for various modules are organized
in different directories. All these directories are put under the directory
called home. However, they can be listed by running help
command. All the administration commands are located under the home/users.
Upon logging into CLI the user enters into the default directory,
home. The current working directory includes the login
name in the command prompt (ex. [root @ home]$ )
The CLI provides commands for navigating between directories,
listing the commands in a directory, and providing help. Any of these
commands may be executed from any directory.
help -o <command>
Displays help and usage text for the specified command. If nothing is specified,
it displays help text for all general commands.
home
This command changes the working directory to home directory.
exit
If the user is working in the home directory, the session
is closed. Otherwise exit
changes the working directory to its immediate parent directory.
ls
Lists all the commands available in the current working directory.
reboot
Reboots
the modem (note: telnet session is lost).
save
Saves the current running configuration into memory. The current setting will remain saved when
the modem is rebooted.
version
Displays the version number of the modem’s firmware.
date
Displays
the current date and time settings.
date –o date
MM:DD:YYYY time H:M:S
Sets
the specified date and time.
erase
Erases
the current stored configuration. The currently used settings are not
altered. The next time the system is rebooted, the system will have
its default (factory) settings.
Warning:
Do not use the save command after the erase command unless the
erase command was performed in error.
This
will show the allocation status of bitmaps like sockets, mbuffs, and
clusters.
To create,
remove, list and change user settings, type users from the home
directory
[root @ user
] $
The ls
command will list five options:
- adduser
- remuser
- setperms
- chpasswd
- listusers
adduser <username> -o -permissions
<A= admin | O= ordinary>
Adds new access user to the system. This command requires that a password be provided.
This is an administrative command and you must be logged in with
administrative rights.
<username>
The name of the user to be added.
-permissions <admin | ordinary>
Specifies the permissions granted to the user. By default the user is granted ordinary permissions.
deluser <username>
Deletes the specified access user. This is an administrative
command and you must be logged in with administrative rights.
setperms {username} [-o permissions ( A )]
Modifies the properties of a user account.
<username>
The name of the user whose services or permissions are to
be modified.
<permissions>
O – ordinary user, A – Administrator
Examples:
Change user xyz from ordinary user to Administrator.
setperms xyz -o A
changepasswd <username>
Changes password of the existing user. To use this command
you must be logged as an Administrator.
listusers
Lists all registered users to use CLI/http/ftp.
The ifconfig
command contains several forms to obtain information or configure an
IP address for an interface. The first form configures the IP address
and other parameters for the specified interface. The remaining forms
display information about the interface(s).
ifconfig
–o <interface_name> inet <address> [netmask <mask>]
[broadcast <addr>]
[up|down]
[mtu <n>]
ifconfig
–o <interface_name>
ifconfig
–o –a
ifconfig
–o –l
<interface_name> The name of the interface. Possible values
are “eth0”, “eth1”, “mer0”, “usb0”, “lo0”, “atm0”, “atm1”, “atm2”, “atm3”,
“atm4”, “atm5”, “atm6”, “atm7”, “ppp0”, “ppp1”, “ppp2,” “ppp3”, “ppp4”,
“ppp5”, “ppp6”, “ppp7”.
<address>
The
IP address to be assigned to the interface. Dot-notation is used to
enter the IP address (for example 192.168.2.1).
netmask
<mask>
The
netmask is used to extract the network part from the IP address. It
also specifies how much of the address is to be reserved for subdividing
the network into sub-networks that are taken from the host field of
the address. Netmask is ‘AND’ed with the interface IP address to get
the network ID that is used in routing, indicating that this network
is reachable through these interfaces. The mask can be specified as
a single hexadecimal number with a leading 0x, for example 0xffffff00,
or with a dot-notation Internet address of 255.255.255.00
broadcast
<addr>
Broadcasting
is used when it makes sense to send the same message to multiple recipients
on the LAN. This option is used to specify the broadcast address to
be used in the network. The default broadcast address is the address
with a host part as all 1’s in the IP address. For example, 192.168.2.255
is a broadcast address for network 192.168.2.0
down
Mark
an interface “down’’. When an interface is marked “down", the system
will not attempt to transmit messages through that interface.
up
Mark
an interface “up’’. This may be used to enable an interface after an
interface was
marked
as “down’’. By enabling the interface, messages can be transmitted through
that
interface.
mtu
<n>
Sets
the maximum transmission unit of the interface to n, the default is
interface specific.
The
MTU is used to limit the size of packets that are transmitted on an
interface. Not all
interfaces
support setting the MTU, and some interfaces, like ethernet, have range
restrictions
(72 – 1500).
-a
Displays
detailed information about all the interfaces.
-l
Lists
the current interfaces.
Examples:
[root @ home] ifconfig –o -a
eth0:
flags=ffff8843<UP,BROADCAST,RUNNING,SIMPLEX,MULTICAST>
mtu
1500 inet 192.168.2.185 netmask 0xffffff00 broadcast 192.168.2.255
ether
08:00:20:c0:c9:74
lo0:
flags=ffff8049<UP,LOOPBACK,RUNNING,MULTICAST> mtu 16384
inet
127.0.0.1 netmask 0xff000000
The
above command lists all the interfaces.
ifconfig
–o –l
Displays
a list of interfaces. It will result in a listing such as "eth0
atm0."
ifconfig
–o eth0
eth0:
flags=ffff8843<UP,BROADCAST,RUNNING,SIMPLEX,MULTICAST>
mtu
1500 inet 192.168.2.185 netmask 0xffffff00 broadcast 192.168.2.255
ether
08:00:20:c0:c9:74
The
configuration of eth0 is listed.
ifconfig
–o eth0 inet 192.168.2.242
Set
the IP address on eth0 to 192.168.2.242
ifconfig
–o eth0 inet 192.168.2.185 mtu 900
Changes
the MTU for the eth0 interface.
ifconfig
–o eth0 inet 192.168.2.185 broadcast 192.168.255.255
Changes
the broadcast address
ifconfig
–o eth0 inet 192.168.2.185 netmask 255.255.00.00
Changes
the netmask.
ifconfig
–o eth0 inet 192.168.2.185 down
Marks
the interface as down.
ifconfig
–o eth0 inet 192.168.2.185 up
Marks
the interface as up.
ifconfig
–o eth0 inet 192.168.2.185 alias 192.168.2.242
ifconfig
-o eth0 inet 192.168.2.185 broadcast 192.168.255.255 netmask
255.255.00.00
mtu 900
Sets
the broadcast address, netmask and mtu for the eth0 interface.
Allows
the user to add, delete, and change a routing entry or allows the user
to get
information
about an entry.
route
add –o -dest <dest_ip_addr> -gateway <gateway_ip_addr> [-netmask
mask] [-mtu value] [-hopcount value]
route
add –o -dest <dest_ip_addr> -interface if_name [-netmask mask]
[-mtu value] [-hopcount value]
route
delete –o -dest <dest_ip_addr>
route
change –o -dest <dest_ip_addr> -gateway <new_ip_addr>
route
get –o -dest <dest_ip_addr>
route
flush
list
routes
route
add is used to add a routing entry. The destination address and
the gateway to reach this destination address must be specified. The
netmask will be computed based upon the class of the destination
address if it is not specified. For example, a netmask of 255.255.255.0
will be taken for a destination address of 192.168.3.0 since this is
a class C address. If the destination is directly reachable via
an interface requiring no intermediary system to act as a gateway, the
interface modifier should be specified. The gateway given is
the address of this host on the common network, indicating the interface
to be used for transmission. Alternately
if the interface is point-to-point, the name of the interface itself
may be given. In this case the route remains valid even if the local
or remote addresses change.
route
delete is used to remove routing entries.
route
change is used to change the gateway for the specified destination
address.
route
get is used to get information for routes to the specified destination.
route
flush will erase all routing table entries.
list
routes will list all routing table entries.
Examples:
route
add -o -dest 192.168.3.0 -gateway 192.168.2.1
Adds
a route entry with destination IP address 192.168.3.0 and gateway as
192.168.2.1.
route
add –o -dest 192.168.3.101 -gateway 192.168.2.1 -interface eth0 -netmask
255.255.255.255
-mtu 1500 -hopcount 2
Adds
a route entry with destination ip address set to 192.168.3.101, gateway
as 192.168.2.1 and interface name to be used for this route as eth0,
netmask as 255.255.255.255, mtu as 1500 and hopcount to 2.
route
delete -o -dest 192.168.3.0
Deletes
the route entry whose destination IP address is 192.168.3.0.
route
change –o -dest 192.168.3.0 -gateway 192.168.2.4
Changes
the gateway to 192.168.2.4 for the entry whose destination addresses
match with
192.168.3.0.
route
get –o -dest 192.168.3.0
Lists
the route entry whose destination IP address is 192.168.3.0.
statistic <ip I tcp | udp | icmp>
Displays statistics for IP, ICMP, TCP and UDP protocols.
list <arp | udp | tcp | routes
| interfaces>
Lists the Address Resolution Protocol (ARP) Table, Routing
Table, and Protocol Control Blocks (PCB) of UDP/TCP sockets in use and
the network interfaces information.
To set the Domain
Name Server.
Commands for setting DNS parameters are in the .dns. directory.
From the .home. directory, type .dns. to enter the directory.
set
-d <domain_name>
set
[–n1 <name_server>] [–n2 <name_server>]
Sets
DNS entries for the system. The domain_name specifies the name
of this domain for the router. The name_server specifies the
IP address of the server resolving DNS requests.
To clear a domain entry, specify double quotes (“”) for the domain
name. To clear the name server entry, specify 0 as the name server.
-n1
<name_server>
Used
to specify the primary name server.
-n2
<name_server>
Used
to specify the secondary name server.
Examples:
[cli
@ dns]$ set -d analog.com
Sets
the domain name to “analog.com”.
[cli @ dns]$ set -d “”
Removes
the domain name.
[cli
@ dns]$ set –n1 137.23.41.2
Sets
the primary name server for DNS queries.
[cli
@ dns]$ set –n1 0
Removes
the primary name server.
list
Lists DNS domain name and name server.
Enables/Disables
the DNS relay function.
dnsr
start -o [<server1>] [<server2>]
dnsr
stop -o [<server1>] [<server2>]
start
Starts
the DNS relay function
stop
Stops
the DNS relay function.
<server1>
IP
address of the primary DNS server.
<server2>
IP
address of the secondary DNS server.
Set and List
domain/nameserver
list
set [-d] ( default domain ) value
set [-n1 / -n2] ( nameserver ) value
dhcp
<interface> start | stop | restart
Configures
an interface to fetch its IP address from a DHCP server. The start
option enables the interface to get the IP address from the DHCP
server. The stop option disables this feature.
The
restart option will stop and then start again negotiation with
the DHCP server for an IP address. Restart is useful to reacquire an
IP address.
Example:
dhcp
eth0 start (note for the USR9003
etho is equal to port ETH1 and eht1 is equal to port ETH2)
The DHCP server commands are located in the “dhcpserver” directory.
Starts
the DHCP server
Stops
the DHCP server.
The
subnet and host commands are used to configure DHCP server. These commands are available in the dhcpserver
directory.
Configuration
of DHCP to serve the specified IP addresses. The add option is
used to
specify
the IP addresses and other aspects of the configuration. The list
option shows the
configured
subnets. The delete command removes the serving of the specified
subnet.
These
commands take effect after the start command has been issued.
These commands
are available
in the dhcpserver directory.
subnet
if add -o -subnet <subnet> [-netmask <mask>] -startip <startip>
-endip
<endip> [-leasetime <lease time in days>] [-broadcast
<broadcast-address>] [-dns <name-server>][-gateway <gateway-address>]
[-server <serverip>] [-file <filename>]
-subnet
<subnet> The subnet that the server will serve IP addresses
on.
-netmask
<mask> The subnet mask for the subnet that the server will
serve IP addresses on.
-startip
<startip> -endip <endip> The range of IP addresses that
will be served. The startip and endip define this range
with the beginning and ending IP addresses to be served. These addresses
are specified in dot notation.
-gateway
<gateway-address> The IP address of the gateway. This information
is passed to the DHCP clients that they use for a default route entry.
By default the IP address of this router is passed to the DHCP clients
as the gateway.
-leasetime
<leasetime> The amount of time the DHCP lease of the IP address
will last. This is specified in days. The
default is 7 days.
-broadcast
<broadcast-address> The IP broadcast address that the server
will listen to for DHCP requests. By default, a standard broadcast address
for the subnet is used.
-dns
<name-server> The
IP address of the DNS server that should be passed to DHCP clients.
By default, the dns address configured on the WAN interface from the
Internet Service Provider (via DHCP server or PPPoA/PPPoE) is used.
-server
<server> -file <filename> These options are used to
support Bootp clients. The client will go to the specified server
to retrieve the specified file as the boot image. The 6489
based router does not support storage of a file for a remote client
to boot from, so the server specified will be another machine on the
network.
subnet
if list
subnet
if delete
Examples:
subnet
add eth0 -o -subnet 192.168.5.0 -startip 192.168.5.200 -endip 192.168.5.210
\
-leasetime
3 -dns 192.168.5.7
IP
addresses will be assigned to up to 11 DHCP clients. The IP addresses
assigned will
begin
with 192.168.5.200 and end with 192.168.5.210. The length of the IP
address
assignment
(the lease) is 3 days. The address of the DNS server (192.168.5.7) will
also be
sent
to the DHCP clients.
subnet
delete eth0 subnet 192.168.5.0
The
DHCP server will no longer serve addresses for the 192.168.5.0 network.
These
commands control the configuration of specific hosts and are useful
when specific
machines
need to have permanent IP addresses assigned. The host
commands have precedence
over subnet commands. The add option is used to specify
the IP address for a particular host. The list option shows the
configured hosts. The delete option will remove a host configuration.
These commands are available in the dhcpserver directory.
host
add -o -macaddr <mac-address> -ipaddr <ipaddr> [-leasetime
<lease time>]
[-broadcast
<broadcast-address>] [-dns <name-server>] [-gateway <gateway-address>]
[-server
<server-name>] [-file <filename>]
host
delete -o -macaddr <mac_address>
host
list
Examples:
host
add -o -macaddr 00.00.00.d1.26.95 -ipaddr 192.168.5.34
Specifies
that the machine with the MAC address of 00.00.00.d1.26.95 will be assigned
the IP address 192.168.5.34.
host
delete -o -macaddr 00.00.00.d1.26.95
Removes
this host configuration for the machine with the MAC address of
00.00.00.d1.26.95.
Leases
represent which IP addresses are allocated to which machines and for
how long. The list option lists all outstanding
leases.
lease
list
lease
delete -o -ipaddr <ipaddr>
RIP
is a protocol that automatically updates the routing entries on the
system. This is done by cooperating with other nearby routers. The RIP
commands are located in the “rip” directory. Two commands are available:
rip and ver. In order for any configuration changes to
take effect, the configuration must be saved (with “save” command) and
the system rebooted.
rip
starts and stops automated updates of routing tables. When RIP is
enabled, the system
communicates
with other routers in the network to update and maintain the IP routing
tables.
By
default, RIP is not enabled. If RIP is enabled but no version is specified,
RIP version 1 is used. This command is available in the “rip” directory.
rip
–o <on|off>
on
Enables
RIP processing.
off
Disables
RIP processing.
Specifies
the version of the RIP protocol that will be used. The permissible values
are 1 or 2. The default is 1.
ver
-o <1|2>
Lists the
routes currently available.
list
Note:
For these new values to take effect, the configuration must be saved.
The next time the system is booted, these values will be in effect.
The
bridge commands are located in the “bridge” directory.
group
<interface_name> <interface_name> -o -if <interface_name>
-if <interface_name>
Assigns
or groups two or more interfaces to the bridge.
interface_name The name of an interface e.g. eth0,
eth1 , atm0 ,atm1 etc.
Examples:
bridge
group eth0 -o -if eth1 -if usb0 -if atm1
The
interfaces eth0, eth1 and usb0 are assigned to the bridge atm1.
bridge
group eth0 -o -if atm0
The
interfaces eth0, and atm0 are assigned to the bridge.
pvc
add <port> <vpi> <vci> <encap> -o [-vpn <OUI>
<vpnId>]
pvc
delete <port> <vpi> <vci> <encap>
Attaches
a PVC to the wan interface.
Add
Adds the specified PVC to the bridge.
Delete
Deletes the specified PVC to the bridge.
<port>
A string identifying the wan interfaces e.g. atm0.
<vpi>
<vci> Virtual Path Identifier and Virtual Circuit Identifier
for the ATM connection.
<encap>
Specifies the encapsulation type. The possible values are llc
or vc which represent Logical Link Control or VC multiplexing
respectively.
-vpn
<OUI> <vpnId> Specifies the VPN encapsulation. The OUI
(Organizationally Unique Identifier) and VPN identifier are specified
as numbers.
cachetimer
<timeout>
Specifies
the idle timeout for bridge table entries. The timeout value is in seconds.
Whenever
there is any traffic passing through the bridge, the bridge will maintain
the lookup table with the MAC addresses coming from configured interface
(through LAN). If the traffic is destined to any MAC address that is
found in the lookup table, that packet is not sent to the ATM interface.
If there is no traffic from a particular machine for a certain time
period, then that entry is deleted from the lookup table. The time that
the bridge will clear the bridge lookup entry is the cachetimer timeout.
setmultiport
enable | disable
Enables
or disables flooding between ATM PVCs.
list
Lists
bridge parameters.
stats
Displays
bridge statistics.
bridge
enable | disable | delete
Enables,
disables, or deletes the configuration of the bridge.
filter
<action> <mac_address> -o [-fwd | -drop]
Configures
the filtering capability of MAC addresses for the bridge. Up to 128
addresses may be specified.
<action>
Action may be add, delete, or modify.
<mac_address>
The MAC address that is to be filtered. The address is specified
by a hex code for each byte separated by a colon (:). For example: 00:01:33:44:5F:2C.
-fwd
When specified, the frame will be forwarded. This is the default.
-drop
When specified, the frame will be dropped.
Examples:
filter
add 1:2:3:4:5:6
Forward
packets whose MAC destination address is 1:2:3:4:5:6.
filter
add 2:3:4:4:5:2 -o -fwd
Forward
packets whose MAC destination address is 2:3:4:4:5:2.
filter
add 11:22:33:44:55:66 -o -drop
Drop
packets whose MAC destination address is 11:22:33:44:55:66
filter
delete 1:2:3:4:5:6
Remove
the filter action for MAC address 1:2:3:4:5:6
filter
modify 2:3:4:4:5:2 -o -drop
Change
the filter action for MAC address 2:3:4:4:5:2 to drop.
filterlist
Lists
the contents of the filter database.
filterflush
Flush
the dynamic entries of the filter database.
The
spanning tree commands are located in the “stp” directory (which is
located in the
“bridge”
directory).
Ethernet
commands are located in the “ethernet” directory.
elink
<interface> -o [[auto] | [10 | 100 | auto_speed ] | [half | full
| auto_duplex]]
Configures
the speed and/or duplex of the Ethernet interface. The default setting
is auto for auto negotiation. With auto negotiation, both the
speed and duplex are configured based upon what the link is connected
to. It is also possible to configure the duplex and specify auto_speed
so that only the speed is auto negotiated. Similarly for auto_duplex.
<interface>
The name of the Ethernet interface. This is eth0.
Auto
Specifies that both the speed and duplex are auto negotiated.
10 Specifies that the speed is set to 10M
bits per second.
100 Specifies that the speed is set to 100M
bits per second.
auto_speed Specifies that the speed is auto negotiated.
Half Specifies half duplex
Full Specifies full duplex
auto_duplex Specifies that the duplex is auto negotiated.
Examples:
[root
@ ethernet]$ elink eth0 -o 10 half
Sets
the Ethernet to a speed of 10Mbps half duplex.
[root
@ ethernet]$ elink eth0 -o auto_speed full
The
speed will be auto negotiated and the link will use full duplex.
setemac
<mac address>
Sets
the Ethernet addresses for the eth0 port. The Ethernet MAC address is
specified in
standard
colon-separated notation.
In
order for the MAC changes to take effect, the configuration must be
saved (using ‘save’ command in the home directory) and the system rebooted.
<mac
address> The MAC address in colon separated notation. Two hex
digits must be supplied between the colons. Twelve hex digits comprise
a MAC address. (i.e. “aa:bb:cc:01:22:05”).
Examples:
[root
@ ethernet]$ setemac 11:22:33:44:55:66
[root
@ ethernet]$home
[root
@ home]$save
The
above will assign 11:22:33:44:55:66 to eth0. This will take effect after
the system is
rebooted.
rmon
<interface>
This
command reads the EMAC RMON counters.
<interface>
The name of the Ethernet interface. This is eth0.
Example:
[cli
@ home]$ rmon eth0
Hardware
link statistics
Rx
frames : 276423
Rx
octets : 53008763
Rx
interrupts: 275055
Rx
CRC errors: 4
Rx
frame errors: 12
Rx
internal errors: 0
Rx
length errors: 268460
Rx
resource events: 0
Tx
frames: 4093
Tx
octets: 456264
Tx
interrupts: 4064
Tx
SQE errors: 0
Tx
carrier sense errors: 0
Tx
deferred: 0
Tx
excessively deferred: 0
Tx
single collisions: 0
Tx
multiple collisions: 0
Tx
late collisions: 0
Tx
internal errors: 0
Hardware
interrupts: 548692
pread
<interface> <port(decimal)>
Reads
PHY register
Examples:
[root
@ ethernet]$ pread eth0 1
Register
1 value 0xffff
Displays
the register 1 value of eth0 interface.
pwrite
<interface> <port(decimal)> <value(hex)>
Writes
PHY register
This
command list is used to get the IP address of diskless system.
add
<0xH/Waddress > <IPAddress >
Used
to add Hardware address and IP address into the DataBase.
<0xH/Waddress
> Hardware address in hexadecimal format.
<IPAddress
> IP address in dot notation.
Examples:
[root
@ rarpd]$ add 0x112233445566 192.168.3.4
Adds
the H/W address and IP Address mapping in the database.
delete
<0xH/Waddress >
Deletes
an entry in the existing RARP DataBase.
<0xH/Waddress
> Hardware address in hexadecimal format.
Examples:
[root
@ rarpd]$ delete 0x112233445566
Deletes
mapping of H/W address 11:22:33:44:55:66 to IP Address, from the database.
list
Lists
the RARP DataBase entries.
Examples:
[root
@ rarpd]$ list
H/W
ADDR IP ADDRESS
11:22:33:44:55:66
192.168.3.4
rarpd
<-a | interface>
Starts
the RARPD on the specified interface or all the interfaces.
Examples:
[root
@ rarpd]$ rarpd eth0
Starts
the RARPD on eth0 interface.
[root
@ rarpd]$ rarpd eth0
If
RARPD is already running the above command, it displays : “Rarpd is
already running on the interface”
[root
@ rarpd]$ rarpd -a
Starts
the RARPD on all the interfaces.
This
command list is used to display logging messages.
log
-o [module name/ log level]
This
command is used to display the log messages based on module name, severity
level, or log messages based on severity level and module name.
<
loglevel > Loglevel can be given as exception, error or info.
<
module name > Module name can be
ll, ip, tcp, udp, sockets ,rawip, icmp, arp, igmp, app, cdcli,
if, telnet, dns, snmp, http, ping, ftp, ftpd, tftp, bootp, dhcpc, dhcps,
qosbw, ipsec, ike, nat, firewall, diffserv, logger, queuing, ipoa, pppoa,
ethoa, httpproxy, ftpproxy
Examples:
[root
@ logger]$ log –o all
“Exception”
level log messages and the error or info level log messages ( if enabled)
will be logged from all modules.
[root
@ logger]$ log –o tcp error
“error”
level log messages from tcp module will be logged.
logSeverity
-o [error/info] [on/off ]
This
command is used to set the specified loglevel as ON or OFF. By default,
error
and
info log level messages are off. There is no on/off option for exception
log level messages. The exception log messages are always displayed
(on).
Examples:
[root
@ logger]$ logSeverity –o error on
Sets
the loglevel error on so that error level log messages are displayed.
[root
@ logger]$ log –o info off
Sets
the loglevel info off, so that info level log messages are not displayed.
logFtpServer
[server_address] [username] [password]
This
command is used to configure the server address, user name, and password
of the
external
ftp server. The log messages are directed to the ftp server given and
are logged into a file by name “fwlogfile”.
Examples:
[root
@ logger]$ logFtpServer 192.168.1.1 xyz xyz123
A
file “fwlogfile” having the log message will be created in the ftp server
192.168.1.1
These
commands are located in the “auth” directory.
adduser
<username> -o -services <cli | ftp | http> -permissions
<admin | ordinary>
Adds
a new user to the system. This command asks to set password for the
user. This is an
administrators
command, ordinary users cannot use this.
<username>
The name of the user to be added.
-services
<cli | ftp | http> Specifies the user privileges. The allowable
privileges are: cli, ftp, or http.
-permissions
<admin | ordinary> Specifies the permissions granted to the
user. By default, the user is granted “ordinary” permissions.
deluser
<username>
Deletes
the specified user. This is an administrators command, ordinary users
cannot use this.
modifyuser
<username> -o -addservices <cli | ftp | http> -delservices
<cli | ftp | http> -permissions <admin | ordinary>
Modifies
the properties of a user account.
<username>
The name of the user whose services or permissions are to be modified.
-addservices
<cli | ftp | http> Adds cli, ftp, or http
services to the user.
-delservices
<cli | ftp | http> Removes cli, ftp, or http
services from the user.
Examples:
modifyuser
xyz –o –addservices ftp –permissions ordinary
Allows
user “xyz” to access the system via ftp. In addition, gives the user
“xyz” ordinary
permissions.
In other words user “xyz” is not an administrator.
modifyuser
abc -o -delservices http
Prohibits
user “abc” from accessing the system via http.
modifyuser
xyz –o –addservices ftp –delservices http –permissions ordinary
Allows
user “xyz” to access the system via ftp and prohibits that user from
accessing the system via http. In addition, gives the user “xyz” ordinary
permissions. In other words, user “xyz” is not an administrator.
changepasswd
<username>
Changes
password of the existing user. This is an administrators command, ordinary
users cannot use this.
listusers
Lists
all current registered users and their allowed services and their permissions.
resetuser
<username>
To
reset the password. This is an administrators command, ordinary users
cannot use this.
These commands
are available from the root menu..
accountstats
< httpproxy/ftpproxy>
This command
is used to display accounting details of specified module.
ftpProxy
-o -auth {enable/disable}
This command
is used to enable authentication for ftpproxy.
httpProxy
-o [-auth {enable/disable}]
httpproxy
-o -display
httpproxy
-o –stat
This command
is used to enable authentication for httpproxy.
Use this command to display and view statistics for the httpproxy.
This command
are available for the root menu.
This command
is used to create an access control list.
addacl module
priority permissions
-o -uid [UserId]
-range [Source Range]
-dest [Destination Address]
-domain [Domain Name]
-mime [Mime Type]
-method [Method]
-url [URL]
-timeofday [DAY1 TIME1 DAY2 TIME2]
module : httpproxy/ftpproxy
permissions : allow/deny
Source Range : [192.168.2.1-192.168.2.6]
Mime Type : application,image,audio,video
Method : get/put
DAY1,DAy2 : sun/mon/tue/wed/thu/fri/sat
TIME1,TIME2 : Hrs:Mins
This command
is used to delete a access control list.
delacl module
ruleid
module : httpproxy/ftpproxy
This command
is used to list access control list by a module.
listacls
module
module : httpproxy/ftpproxy
Snmp
commands allow listing and setting of current SNMP configuration.
list
This
command lists the current SNMP configuration like system version, system
contact, system location, system id, etc.
Example:
List
Current SNMP Configuration
System Version Description : U.S.Robotics
Corp,SureConnect ADSL Ethernet/USB Router
System Contact : Phone: 1-800-874-2000
System Location : Schuamburg,II,USA
System ID : 1 3 6 1 4 1 4242 255
Default Trap Address : 192.168.1.1
Communites :
for reading MIB : public
for modifying MIB[1]: pub
for modifying MIB[2]: chip
set
[-d] [-c] [-l] [-i] [-t] [-s1] [-s2] value
This
command allows modification of any current SNMP configuration.
-d
value System Version Description
-c
value System Contact.
-l
value System Location
-I
value Assigned Enterprise Number.
-t
value Trap Server IP Address.
-r
value Community for reading MIB.
-s1
value Community for modifying MIB.
-s2
value Community for modifying MIB.
shutdown
This
command shuts down the SNMP agent.
Option:
snmp list / set [-d] [-c] [-l] [-i] [-t] [-s1]
[-s2] value
-d : System
Version Description
-c : System
Contact
-l : System
Loaction
-i : Assigned
Enterprise Number
-t : Trap
Server IP Address
-r : Community
for reading MIB
-s[1][2]: Community for modifying MIB
shutdown : To shutdown the agent
The
‘adsl’ directory contains commands to configure and gets the status
information of the ADSL link.
setmode
<mode>
Sets
the mode of the ADSL link to ANSI (T1.413), G.DMT, G.Lite, or multi-mode.
After
executing
this command, the configuration can be saved and the next time the machine
is
rebooted,
the mode will take effect.
<mode>
The mode may be ansi, gdmt, glite, or multi.
readcmv
<cmv_index> <offset>
The
ADSL Configuration and Management Variables (CMV) can be read with the
readcmv command. The CMV variables are documented in “CMV Reference
Manual”. This command will only provide meaningful results when the
link is operational.
<cmv_index>
The cmv index may be one of the following values.
Note
that they must be specified in uppercase: ADPT, CNTL,
CODE, DIAG, DOPT, FLAG, INFO, INTL,
MASK, OPTN, PFCL, PFRX, PFTX, PSDM,
RATE, RXDA, STAT, TEST, TONE, TXDA,
UOPT.
<offset>
This
is a numeric value between 0 and 65535.
writecmv
<cmv_index> <offset> <value>
The
ADSL Configuration and Management Variables (CMV) can be written with
the writecmv command. The CMV variables are documented in “CMV Reference
Manual”. This command will take effect only after the link is reconnected.
<cmv_index>
The cmv index may be one of the following values.
Note
they must be specified in uppercase: ADPT, CNTL, CODE,
DIAG, DOPT, FLAG, INFO, INTL, MASK,
OPTN, PFCL, PFRX, PFTX, PSDM, RATE,
RXDA, STAT, TEST, TONE, TXDA, UOPT.
<offset>
This
is a numeric value between 0 and 258.
<value>
The
value for the variable specified in hexadecimal format.
1.20.4
mon
mon
Displays
the state of the ADSL connection. Only gives meaningful information
when the link is operational.
addusercmv
<cmv_name> <offset> <value> <command> <msgid>
Allows
the adding or setting of a CMV. The CMV values will be used the next
time the system is rebooted. Note that the configuration must be saved
after using this command in order for them to take effect on the next
reboot.
<cmv_name>
The following values are permitted for the cmv name: MASK,
OPTN, PSDM, RXDA, TEST, TXDA, or
ADPT.
<offset>
The
offset value which is a decimal in the range of 0 to 65535.
<value>
Value
of the CMV. Value is expected in hexadecimal format.
<command>
Type
of operation ( Read or Write ).
<msgid>
Message
Id in decimal digits.
delusercmv
<index>
Deletes
the specified user CMV. The user cmv was added with the “addusercmv”
command.
<index>
Index
of CMV as displayed by “listusercmv”.
listusercmv
Lists
the User CMVs added by the ‘addusercmv’ command.
eread
<offset> <size>
Displays
the Eagle 16 bit data memory
<offset
>.
0
- 3ffff (hexadecimal)
<
size >
1
- 256 (decimal)
ewrite
<offset> <value>
Writes
1 16-bit word into Eagle 16 bit data memory.
<offset
>
0
- 3ffff (hexadecimal)
<
value >
0
- ffff (hexadecimal)
mwrite
<offset> <value>
Writes
1 32-bit word into Eagle 16 bit data memory.
<offset
>
0xa0000000
- 0xbfffffff (hexadecimal)
<
value >
0
- ffffffff (hexadecimal)
mread
<offset> < size >
Displays
the Falcon 32 bit data memory.
<offset
>
0xa0000000
- 0xbfffffff (hexadecimal)
<
size >
1
- 100 (decimal)
dhcpr
start -o <remote_server>
dhcpr
stop
dhcpr
status
Configures
the DHCP Relay function. The system acts as a proxy for DHCP requests.
When enabling the DHCP Relay, the address of the DHCP server is specified
and DHCP requests are relayed to the specified server. On enabling DHCP
relay functionality, the DHCP server functionality gets disabled (if
it is enabled) and vice versa.
start
-o <remote_server> Starts DHCP relay. The remote_server
is the IP address of the DHCP server.
Stop
Disables or stops the DHCP relay service.
Status
Shows the status of the DHCP Relay.
igmp
-o -proxyif <interface>
igmp
-o -routerif <interface>
igmp
-o -deleteif <interface>
igmp
-o -display
Used
for configuring igmp proxy and router interfaces.
-proxyif
<interface> Sets the proxy interface. Typically a LAN interface
(eth0) is specified.
-routerif
<interface> Sets the router interface. Typically a WAN interface
(ATM0, PPP0) is specified.
-deleteif
<interface> Deletes either the proxy or router interface.
-display
Displays the group in all interfaces.
The following
commands are available in the “qosc” directory
addrule prority -o [-da address]
[-sa address] [-p protocol] [-dp portNum] [-sp portNum]
[-tos serviceType] [-type icmp-types]
[-flg tcp-flags] [-tc actionID] [-fw actionID]
The addrule command provides a mechanism to specify an action
(Firewall or Traffic Conditioning) to packets matching a user specified
criteria. One or more of the
following packet header fields can be used in the specification criteria: destination IP address, source IP address, destination
port, source port, and protocol (TCP, UDP, or ICMP). Every rule must be associated with at least
one action. Before adding
a rule, the specified action must already be available in the system.
<priority>
The priority for this rule. Since there can be many rules configured and it is possible for a
packet to match several different rules, the priority is used to break
ties. The priority values range
from the highest priority 0 to the lowest priority 65531. By default the minimum priority value (65535) is assigned if the
priority is not specified.
-da <ip_address>
Specifies that one of the criteria for a match is the destination
address of the IP packet header. The
ip_address must be specified in dot-notation. The prefix_length is used to specify
the size of the netmask. The
value for prefix_length from 12 to 32.
-sa <ip_address>[/<prefix_length>]
Specifies that one of the criteria for a match is the ource
address of the IP packet header. The
ip_address must be specified in dot-notation. The
prefix_length is used to specify the size of the netmask. The
value for prefix_length from 12 to 32.
-dp [operator]<port>
Specifies that one of the criteria for a match is the destination
port of the IP packet header. The
port is a numeric value from 0 to 65,531. Optionally an operator may be specified
so that many ports can be matched. The
operators supported are: <, >, =.
-sp [operator]<port>
Specifies that one of the criteria for a match is the source
port of the IP packet header. The
port is a numeric value from 0 to 65,531. Optionally, an operator may be specified
so that many ports can be matched. The
operators supported are: <, >, =.
-tos [operator] <class>
The Type Of Service flag causes the type of service field
in the packet header to be marked with the specified value. Based upon this marking, the packet will be
given the applicable priority if the transmitting interface has a Queuing
mechanism enabled. The class
may be any one of the following:
Priority Alternative
Priority
Comment
rt Ef real time traffic
ct af1 critical traffic
hi af2 high priority traffic
md af3 medium priority traffic
lo af4 low priority traffic
df default
Optionally an operator may be specified so that many
ports can be matched. The operators
supported are: <, >, =.
-flgs <tcp_flags>
This field represents the TCP flags SYN, URG, RST, FIN, ACK
-typ <icmp_types>
ICMP packet types such as ECHO REQ, ECHO REPLY, DEST UNREACH
etc
Note: To assign an Action
ID to a rule, you must create or use an existing Action ID before using
AddRule command.
-tc <action_id> <not
support in the USR9003>
Packets matching the criteria specified in this rule will
be processed with the specified Traffic Conditioning action. The Traffic Conditioning action is identified
by the action_id. The
action_id was returned by an addtc <not support
in the USR9003> command.
-fw <action_id>
Packets matching the criteria specified in this rule will
be processed with the specified Firewall action. The Firewall action is identified by the action_id. The action_id was returned by addfw command.
Examples:
addrule 5 -o -sa 192.168.2.1/24
-da 192.168.3.4 -p tcp -dp <2334 -sp 4546 -tos ef -fw 3
Packets with a source IP address of 192.168.2.1, a destination
address of 192.168.3.4, and using a TCP destination port less than 2334
will have its TOS field marked with high priority and will be processed
by Firewall action #3.
addrule 6 -o -sa 192.168.2.1 -da
192.168.3.4 -p icmp -dp >2334 -sp 4546 -tc 1 -fw 2
Packets with a source IP address of 192.168.2.1, a destination
address of 192.168.3.4, a source port of 4546, and using an ICMP destination
port greater than 2334 will have a source portprocessed by Traffic Conditioning
action #1 and Firewall action #2.
deleterule <rule_id> -[<action_type>]
Deletes a configured rule. The
rule_id is a Rule Identifier that is returned by addrule. Rule Identifiers are also listed in the listrules
command. If action_type is
specified (as tc or fw), then only the action part is
deleted and not the rule. If
the action type is not specified or if the specified action type is
the only action present in the rule, then the rule is also deleted.
<rule_id>
The rule identifier returned by addrule. Rule identifiers are also listed by listrules.
-<action_type>
The action_type option can be tc for Traffic Conditioning
or fw for Firewall action. This
deletes the action part of the rule.
Note: If the rule has only one action
specified with it, the entire rule is deleted as well.
Examples:
deleterule 1
Deletes the rule whose identifier is 1.
deleterule 2 -tc
Deletes rule number 2’s traffic conditioning action. If rule 2 does not have any other actions, the
rule is also deleted.
listrule <rule_id>
Displays details about a configured rule whose identifier
is rule_id.
Example:
listrule 1
ID: 1 PRI: 30000 [SRC: 192.168.1.0/24]
[FW: 1]
listrules
Displays details of all configured Rules.
Example:
Listrules
ID: 1 PRI: 30000 [SRC: 192.168.1.0/24]
[FW: 1]
ID: 2 PRI: 29000 [DP: =67] [FW:
2]
listroutes
Displays
the router’s routing table.
Example:
listroutes
Internet
Routing Table
Destination
Gateway
Netmask
----------------------------------------------- ------
127.0.0.1
127.0.0.1
192.168.1.0
0: 0: 0: 0: 0: 0 255.255.255.0
224.0.0.0
0: 0: 0: 0: 0: 0 255.0.0.0
listarps
Displays
the router’s arp table.
Example
listarps
ARP
Table
destination
addr Link Address
----------------------------------------
192.168.1.3
0: 4:76:3f:6e:9c
224.0.0.1
1: 0:5e: 0: 0: 1
Network
Address Translation (NAT) hides internal IP addresses of a network from
the outside world and provides access to the Internet for multiple machines
using a single or fixed number of public IP addresses. The NAT framework
supports both dynamic and static NAT. The nat command enables
dynamic NAT processing
With
the nat command, all private addresses are mapped to the IP address
of the specified WAN interface.
nat -o [-interface <interface>] [-alias_address <addr>] [-unregistered_only yes|no] [-same_ports yes|no] [-disable] [-status]
- interface <interface>
Configures the specified WAN interface to use dynamic Network
Address Translation. For all packets transmitted from the WAN interface,
the source address is modified to use IP address of the WAN interface. The
source port of the packet may be modified, as required. Packets received on the WAN interface will have
their destination address modified appropriately to reach the appropriate
machine on the LAN network.
-alias_address <ip_address>
The source address field of the outbound packets from the
WAN interface will be overwritten with the specified ip_address.
-unregistered_only [yes | no]
If yes, only the outbound packets with unregistered source
IP addresses are translated. All the outbound packets with the registered
source IP addresses are forwarded on the WAN interface without translation.
This is useful if you have one more subnet having registered IP addresses
that share the common WAN link with the subnet having unregistered IP
addresses.
Registered addresses are addresses reachable and advertised
in the Internet, whereas unregistered addresses are private addresses
which are not reachable through the Internet. Currently there is no
command to display registered addresses.
-same_ports [yes | no]
If yes, nat will try to retain the source port without modification
for outgoing packets. This can
only be done if the port is not already in use by another connection.
The default is yes.
-disable
The Option is used to disable the nat interface.
-status
This will display all the configured options on nat interface.
Examples:
nat -o -interface atm0
Configures the WAN interface atm0 to use network address translation.
nat -o -alias_address 202.54.30.50
Configures alias address as 202.54.30.50 and maps this IP
address to an interface and takes that as NAT interface.
nat .o -unregistered_only yes
Tells the NAT module to translate only those outgoing packets
that bear an unregistered IP address in the source address field of
the packet header.
nat .o -same_ports yes
Tells the NAT to try retaining the same source port while
translating outbound packets. However, if this causes conflict with
existing entries in the NAT table, then source port will be modified.
nat -o -disable
Disables the nat interface.
nat -o -status
Displays all the options on nat interface.
(This command
is not supported for the USR9003 router. Use the Menu system or the
Web Interface to create or delete Static NAT routes or Range Port maps)
(This
command is not supported for the USR9003 router. Use the Menu system
or the Web Interface to create or delete Static NAT routes or Range
Port maps)
(This
command is not supported for the USR9003 router. Use the Menu system
or the Web Interface to create or delete Static NAT routes or Range
Port maps)
maplist
Display the
current mappings for NAT configurations.
Example:
maplist
Local address
range Alias address
------------------------------------------
192.168.1.1
192.168.1.10 210.134.100.0
------------------------------------------
Port range
mappings [WAN to LAN]...
Alias address
Port range Local
address Port range Protocol
------------------------------------------------------------------------
210.168.0.1
60 - 78 192.168.1.10 70 - 88 TCP
------------------------------------------------------------------------
addpublic <public_addr >
<public_addr>
The public IP address to be entered. Dot notation should be used.
Examples:
addpublic 217.11.52.34
Enters the public IP address 217.11.52.34.
delPublic <index>
Removes the entered IP addresses specified by addpublic. The index specifies a particular IP address. The
indexes are specified with the listpubaddrs command.
listpubaddr
Lists the public IP addresses that were entered with addpublic.
links
Display all
logic links in NAT table.
Example:
links
LOCAL-ADDR/PORT ALIAS-ADDR/PORT REMOT-ADDR/PORT LINK/EX.TIME IN/OUT-PKTS
~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~
~~~~~~~~~~~~~~~ ~~~~~~~~~~~~ ~~~~~~~~~~~
192.168.1.3
0.0.0.0
192.168.1.1
TCP 657
2217 0 23
172800 1105
|
addfw action -o [-ifa interface]
[-dir direction] [-code icmp code]
action : allow, deny,
reject, reset, unreach,
interface : any vaild interface of the system
direction : in or out, default all direction
icmp code : any for the follwing code mentioned
unreach net(default) - 0
unreach host - 1
unreach port - 3
unreach srcfail
- 5
unreach net-unknown - 6
unreach host-unknown - 7
unreach isolated - 8
unreach net-prohibited - 9
unreach host-prohibited - 10
unreach filter-prohibited - 13
Adds a firewall action. An
action identifier is returned which can be used with the addrule
command. The addrule
command is used to specify the types of packets that will be given this
action.
<action>
Specifies what happens when the packet enters. The following actions are possible:
Action Comment
Allow - Permits the
packet to enter or leave the system.
Deny - Drops the packet.
Reset - Forces the
TCP connection to be reset.
Reject - Drops the
packet and issues an .unreach host. ICMP error.
Unreach - Drops the
packet and sends the ICMP error specified with the -error_code
option.
Divert - Changes the
destination port of the packet. See
the -port option.
-ifa <interface>
The name of the interface that this firewall action applies
to. Typically this is the WAN
interface (atm0, ppp0).
-dir <direction>
Specifies whether the action applies to incoming, outgoing,
or both incoming and outgoing traffic. The
allowable values for direction are in or out. If not specified, the action applies to both
incoming and outgoing traffic.
-code <icmp_code>
This ICMP error code is issued when the unreach action
is used.
Code Meaning
0 unreach net (default)
1 unreach host
3 unreach port
5 unreach srcfail
6 unreach net-unknown
7 unreach host-unknown
8 unreach isolated
9 unreach net-prohibited
10 unreach host-prohibited
13 unreach filter-prohibited
Examples:
addfw reset –o -ifa atm0
addrule 6 -da 216.11.52.34 -dp 23
-p tcp -fw 1
The rules above, results in all attempts via telnet from any
host to 216.11.52.34
being reset.
First, the addfw command defines the firewall action of
reset for the traffic coming from the atm0 interface. The addfw
command returns an identifier, suppose for this example that 1 is returned. Next, the addrule command defines telnet
from any host to 216.11.52.34 and using the -fw option it
links the reset action as specified with the addfw
command.
addfw unreach –o -code 1
addrule 6 -da 192.168.7.25 -p icmp
-fw 3
The two rules above specify that all ICMP packets destined
to 192.168.7.25 will result in the message "ICMP Host Unreachable"
being sent back to the sender. First, the addfw command defines
a Host Unreachable action. Next, the addrule command defines
ICMP flow to 192.168.7.25, and using the -fw option, it links
the unreach action to this flow.
listallfw
Displays all firewall actions.
Example:
listallfw
Id Interface Direction
Day-Time To Day-Time Action
1 eth0 in sun 0:00 sat 23:59 allow
2 any any sun 0:00 sat 23:59 allow
3 atm0 any sun 0:00 sat 23:59 reset
4 any any sun 0:00 sat 23:59 unreach
host
listfw <id>
Displays all configured parameters of the specified action
identfier.
Example:
listfw 4
FIREWALL ACTIONS
-----------------
Id Interface Direction
Day-Time To Day-Time Action
4 any any sun 0:00 sat 23:59 unreach host
delfw <id>
Deletes the specified firewall action. The id is returned from the addfw
command and is also listed in the listallfw command.
vcadd
<vpi> <vci> <service> <encaps> -o [-peak <val>]
[-avg <val>] [-mbs <val>]
[-cdvt
<val>]
Establishes
a Permanent Virtual Circuit (PVC) with the specified traffic descriptors.
The service
specifies the traffic type of the PVC. Permissible values are: cbr,
rtvbr, nrtvbr, or ubr. The adaptation parameter
is used to specify the type of ATM adaptation layer for which permissible
values are aal5 for data connections and aal2 for voice
connections.
<vpi>
<vci> Virtual Path Identifier (VPI) and Virtual Channel Identifier
(VCI) that identifies this ATM connection. The vpi is an integer
number which can range from 0 to 255. The vci is an integer number
which can range from 0 to 65,535.
<service>
The service specifies the kind of traffic shaping. The possible
values are cbr, rtvbr, nrtvbr, or ubr.
The
following table briefly describes these options.
Service
|
Name
|
Description
|
cbr
|
Constant
Bit Rate
|
Supports
real-time applications requiring a fixed amount of bandwidth.
The applications produce data at regular rates.
|
rtvbr
|
Real
Time
Variable
Bit Rate
|
Supports
time-sensitive applications such as voice. In these applications
the rate at which cells arrive are varied.
But these cells need to be delivered in a timely manner
with minimal delay.
|
nrtvbr
|
Non
Real Time
Variable
Bit Rate
|
Supports
applications that have no constraints on delay and delay variation,
but still have variable-rate and bursty traffic characteristics.
Applications include packet data transfers, terminal sessions,
and file transfers.
|
ubr
|
Unspecified
Bit Rate
|
Best
effort service that does not require tightly
constrained
delay and delay variation. UBR provides
no
specific quality of service or guaranteed throughput. The traffic
is “at risk” because the network
provides no performance guarantees for UBR traffic. The traffic
descriptor is similar to IP’s “best effort” approach to traffic
management.
|
<encaps>
Specifies whether ATM Adaptation Layer is aal2 or aal5.
For voice (not support by USR9003) connections, AAL2 must be specified.
For data connections, AAL5 must be specified.
-peak
<value> Defines the
fastest rate a user can send cells to the network. It is expressed in
units of cells per second.
-avg
<value> Defines the maximum sustainable/average rate a user
can send cells to the network. It is expressed in cells per second.
This specifies the bandwidth utilization. This value must always be
less than or equal to the Peak Cell Rate (see -pcr option).
-mbs
<value> Maximum number of cells the user can send at the peak
rate in a burst, within the sustainable rate.
-cdvt
<value> Constrains the number of cells the user can send to
the network at the maximum line rate. It is expressed in microseconds.
Examples:
vcadd
0 38 cbr aal2 -o -peak 1600 -mbs 25 -cdvt 50000
The
following creates a PVC (vpi - 0,vci - 38). Service class is cbr (Constant
Bit Rate) and encapsulation as aal2 (for voice). The traffic descriptors
are set for peak cell rate of 1600kbps, burst size of 25 cells, and
cell delay variation of 50000 microseconds.
vcadd
0 39 ubr aal5
The following creates a PVC (vpi=0, vci=39). Service class is ubr (Unspecified
Bit Rate) and encapsulation is aal5 (for data).
deletevc
<vpi> <vci>
Deletes
the specified PVC. The PVC is identified by the vpi / vci values.
Example:
deletevc
0 39
Deletes
a PVC with vpi=0 and vci=39.
showatmconn
Lists
the existing PVCs.
Example:
showatmconn
ATM
INTERFACE CONFIGURATION INFORMATION
MAX
INTERFACE VPC’s : 10
MAX
INTERFACE VCI’s : 255
ILMI
VPI VALUE AT THIS INTERFACE : 0
ILMI
VCI VALUE AT THIS INTERFACE : 16
INTERFACE
ADMINISTRATIVE ADDRESS : 137.71.139.250
ACTIVE
VCC CONNECTIONS AT THIS INTERFACE : 2
atmstats
Lists
the AAL5 and ATM statistics.
f5lb
<vpi> <vci> <flow_type> -o <LLID>
This
command initiates an F5 loopback.
<vpi>
Virtual Path Identifier for the ATM connection.
<vci>
Virtual Circuit Identifier for the ATM connection.
<flow_type>
Specifies segment (seg) or end-to-end (ete).
<LLID>
The loopback identifer. This is specified as 32 hex digits. The
default is:
FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF
vpadd <id>
<vpi> <service> -o [-peak <val>][-avg <val>] [-mbs
<val>] [-cdvt <val>]
This
command allows the adding and configuring of an atm connection.
<id>
Connection identification
<
vpi > vpi number
<
service > cbr / rtvbr / nrtvbr / ubr
<peak
val>
Peak
cell rate (in cells/s)
<avg
val >
Average/minimum
(SCR) cell rate (in cells/s)
<mbs
val >
Burst
size in cells
<cdvt
val >
Cell
delay variation tolerance (in micro secs)
The following
commands are available under the “sndcp” directory.
routedbridge
<interface> disable <vpi><vci>
routedbridge
<interface> enable <vpi><vci> -o <-enc encapsulation>
<-vpn OUI
vpnId>
Configures
the specified WAN interface to use Routed Bridge which is RFC 2684 routing.
Note: The Maximum Transfer Unit
(MTU) for the Routed Bridge is 9182.
Interface
The name of the WAN interface. Typically this is ‘atm0’.
Enable
Enables this Routed Bridge interface.
Disable
Disables this Routed Bridge interface.
<vpi>
<vci > These are the vpi, vci values on which the Routed Bridge
has to be enabled/disabled. vpi,vci are assigned with the vcadd command.
The showatmconn command can also be used to list the current
ATM connections with their respective vpi and vci values. (Note the
vcadd and showatmconn commands are located in the “atm”
directory).
-enc
LLC | VC Specifies the encapsulation type. The possible values are
‘llc’ or ‘vc’, which represent Logical Link Control or VC multiplexing
respectively.
-vpn
OUI vpnId Enables VPN encapsulation. OUI is organizationally unique
identifier. VpnId is VPN index.
Example:
routedbridge
atm0 enable 0 100 –o -enc LLC
Establishes
a Routed Bridge connection on the WAN interface atm0. VPI, VCI values
0, 100 is used for the ATM connection. LLC encapsulation will be used.
routedbridge
atm0 disable 0 100
Disables
the Routed Bridge connection.
ipoa <interface>
disable <vpi><vci> -o [default] [-nhp <ip_address>]
ipoa
<interface> enable <vpi><vci> -o [-enc LLC|VC] [default]
[-nhp <ip_address>]
[-vpn
<OUI> <vpnId>]
Configures
the specified WAN interface to use IPoA, which is Classical IP over
ATM including Inverse ATM Arp. IPoA uses Inverse ATM Arp to get the
peer IP address. The Maximum Transfer Unit (MTU) for IPoA is 9182.
Note:
In this case, if the peer does not support Inverse ATM Arp, then there
will not be any traffic flow. If the nexthop (-nhp option) or
default PVC is configured per IPoA, then it does not use Inverse
ATM Arp to get the peer IP address.
Interface
The name of the WAN interface. Typically this is ‘atm0’.
Enable
Enables this IPoA interface.
Disable
Disables this IPoA interface.
<vpi>
<vci > These are the vpi, vci values on which ipoa has to
be enabled/disabled. vpi,vci are assigned with the vcadd command.
The showatmconn command can also be used to list the current
ATM connections with their respective vpi and vci values. (Note the
vcadd and showatmconn commands are located in the “atm”
directory).
-enc
LLC | VC Specifies the encapsulation type. The possible values are
‘llc’ or ‘vc’ which represent Logical Link Control or VC multiplexing
respectively.
Default
If an entry does not exist for the destination in the inverse ATM
Arp table, then the packet is forwarded on the PVC specified.
-nhp
<ip_address> Specifies the next hop IP address of the peer-end.
-vpn
<OUI> <vpnId> Specifies the VPN encapsulation. The OUI
(Organizationally Unique Identifier) and VPN identifier are specified
as numbers.
Example:
ipoa
atm0 enable 0 100 –o -enc LLC
Establishes
an IPoA connection on the WAN interface atm0. VPI, VCI values 0, 100
is used for the ATM connection. LLC encapsulation will be used.
ipoa
atm0 disable 0 100
Disables
the IPoA connection.
list
<param>
Displays
the configurations of IPOA/BRIDGE/ROUTEDBRIDGE.
<param>
param
can be bridge / routedbridge / ipoa.
Example:
list
bridge
Diplays
Bridge parameters.
list
routedbridge
Diplays
Routed Bridge parameters.
list
ipoa
Diplays
IPoA parameters.
pppoe
<profile> -o <-if Interface> <-encap Encapsulation>
<-restarttime Timeout >
<-auth Auth> <-myaddr IPAddr> <-peer
PeerIPAddr> <-mtu MTU> <-mru MRU>
<-hwaddr Ethaddr> <-service ServiceName>
<-acname ACName> <-tag HostTag>
<-user Username> <-pass Password>
<-vpi Vpi> <-vci Vci> <-mode Mode>
<-idletime idleTimeout> <-nat [enable/disable]>
<-netmask mask> <-vpn OUI vpnId>
Sets up a PPPoE profile.
Profile
Profile number to configure. Specify an integer number from 0 through
7.
-if
<interface> Interface name with unit number. Four PPP interfaces
are available: ppp0, ppp1, ppp2, ppp3, ppp4, ppp5, ppp6, ppp7
-encap
<encapsulation> Encapsulation type. Possible values are LLC
(Logical Link Control) or VC (VC Multiplexing).
-restarttime
<timeout> Timeout in milliseconds. The default is 3 seconds
(3000 milli seconds).
-auth
<authentication> Authentication type (pap, chap,
mschapv1, mschapv2).
-myaddr
<ip_addr> Desired self IP Address (eg 192.168.26.7). Expressed
in dot notation.
-peer
<peer_addr> Peer IP Address to optionally specify the address
of the Internet Service Provider. Expressed in dot notation.
-mtu
<mtu> Maximum Transmission Unit expressed in bytes. The default
is 1492.
-mru
<mru> Maximum Receive Unit, negotiated in LCP. The default
is 1492.
-hwaddr
<addr> Hardware address of the router for this connection.
Typically, one of the Ethernet hardware addresses of the router are
used for this. The address is specified with ‘:’ used as a delimiter
between byte values (eg 10:11:12:13:14:15).
-service
<service_name> Service Name.
-acname
<ac_name> Access Concentrator name.
-tag
<host_tag> Use host unique tag.
-user
<user> Username. This string can be up to 30 characters.
-pass
<password> Password. This string can be up to 30 characters.
-vpi
<vpi> The ATM vpi value which was assigned in a vcadd command
or listed in a atmshowconn command.
-vci
<vci> The ATM vci value which was assigned in a vcadd command
or listed in a atmshowconn command.
-mode
<mode> Mode can be AUTO or DIRECT. In case the mode is set
to AUTO, the PPPoE negotiation starts only when the system identifies
any traffic required to be transferred on the link. In case the mode
is set to DIRECT, the PPPoE negotiation is started manually using the
“pppoestart” command. The default mode is DIRECT.
-idletime
<idletime> The value of idletime is given in minutes and this
value indicates how long the link remains up when there is no data transfer
over the link. The idle time works only when used in combination with
mode AUTO. The default is 60 seconds.
-nat
enable|disable Enables or disables NAT (Network Address Translation)
for this PPP interface. The default is for NAT to be disabled.
-netmask
<mask> Specifies the netmask for the PPP interface. The mask
is specified in dot notation (i.e. 255.255.255.0).
-vpn
<OUI> <vpnId> Specifies the VPN encapsulation. The OUI
(Organizationally Unique Identifier) and VPN identifier are specified
as numbers.
Example:
pppoe
1 –o -if ppp0 -vpi 0 -vci 100 -user jones -pass Indiana
Defines
a PPPoE profile. The ppp0 interface is used with the ATM connection
vpi 0 and vci 100. The user name is “jones” and the password is “Indiana”.
pppoestart
<Profile>
Starts
PPPoE given the specified profile. The profile is specified with an
integer (0, 1, 2). The profile was previously specified with the pppoe
command.
pppoestop
<Profile>
pppoestop
<Profile>
Stops
PPPoE given the specified profile. The profile is specified with an
integer (0, 1, 2). The profile was previously specified with the pppoe
command.
pppoestop
<Profile>
pppoelist
[-profile Profile]
Displays
the listing of all available free profiles. If -profile is not
specified, this command will display all the valid configured profiles.
pppoedefault
<profile>
Configures
the specified profile as the default PPPoE connection. This profile
must be using “auto” mode. Out of all the profiles that are using the
“auto” option, only one can be run at a time. This command is used to
specify that profile. If the “pppoedefault” command is not used, the
first profile that used the “auto” option is used as the default.
pppoedel
<profile> | all
Deletes
the specified profile. Profile is specified as a number (see pppoe command).
If all is specified, then all profiles are deleted. This command
only deletes inactive profiles. If a profile is in use, it must be stopped
before it can be deleted.
pppoa
<profile> -o <-if Interface> <-encap Encapsulation>
<-restarttime Timeout
>
<-auth Auth> <-myaddr IPAddr> <-peer PeerIPAddr> <-mtu
MTU> <-mru MRU>
<-user Username> <-pass Password>
<-vpi Vpi> <-vci Vci> <-nat [enable/disable]> <-netmask
mask> <-vpn OUI vpnId>
Sets
up a PPPoA profile.
Profile
Profile number to configure. Specify an integer number from 0 through
7.
-if
<interface> Interface name with unit number. Eight PPP interfaces
are available: ppp0, ppp1, ppp2, ppp3, ppp4, ppp5, ppp6, and ppp7.
-encap
<encapsulation> Encapsulation type. Possible values are LLC
or VC.
-restarttime
<timeout> Timeout in milliseconds. The default is 3 seconds
(3000 milli seconds).
-auth
<authentication> Authentication type (PAP or CHAP).
-myaddr
<ip_addr> Desired self IP Address (eg 192.168.26.7). Expressed
in dot notation.
-peer
<peer_addr> Peer IP Address to optionally specify the IP address
of the Internet Service Provider. Expressed in dot notation.
-mtu
<mtu> Maximum Transmission Unit expressed in bytes. The default
is 1500.
-mru
<mru> Maximum Receive Unit, negotiated in LCP. The default
is 1500.
-user
<user> Username.
-pass
<password> Password.
-vpi
<vpi> The ATM vpi value which was assigned in a vcadd command
or listed in a atmshowconn command.
-vci
<vci> The ATM vci value which was assigned in a vcadd command
or listed in a atmshowconn command.
-nat
enable|disable
Enables
or disables NAT (Network Address Translation) for this PPP interface.
The default is for NAT to be disabled.
-netmask
<mask> Specifies the netmask for the PPP interface. The mask
is specified in dot notation (i.e. 255.255.255.0).
-vpn
<OUI> <vpnId> Specifies the VPN encapsulation. The OUI
(Organizationally Unique Identifier) and VPN identifier are specified
as numbers.
Example:
pppoa
1 –o -if ppp0 -vpi 0 -vci 100 -user jones -pass Indiana
Defines
a PPPoA profile. The ppp0 interface is used with the ATM connection
with vpi 0
and
vci 100. The user name is “jones” and the password is “Indiana”.
pppoastart
<Profile>
Starts
PPPoA given the specified profile. The profile is specified with an
integer (0, 1, 2). The profile was previously specified with the pppoa
command pppoastop <Profile>
pppoastop
<Profile> Stops PPPoA given the specified profile. The profile
is specified with an integer (0, 1, 2). The profile was previously specified
with the pppoa command.
pppoastop
<Profile>
pppoalist
[-profile Profile]
Displays
the listing of all available free profiles. If -profile is not
specified, this command will display all the valid configured profiles.
pppoadel
<profile> | all
Deletes
the specified profile. Profile is specified as a number (see pppoa command).
If all is specified, then all profiles are deleted. This command only
deletes inactive profiles. If a profile is in use, it must be stopped
before it can be deleted.
pppoadefault
<profile>
Configures
the specified profile as the default PPPoA connection. This profile
must be using “auto” mode. Out of all the profiles which are using the
“auto” option, only one can be run at a time. This command is used to
specify that profile.
liststat
<param>
Displays
the status of IPOA/BRIDGE/ROUTEDBRIDGE/PPPOE/PPPOA.
<param>
param can be bridge / routedbridge / ipoa / pppoa / pppoe.
Example:
liststat
bridge
Diplays
Bridge status
liststat
routedbridge
Diplays
Routed Bridge status
liststat
ipoa
Diplays
IPoA status
liststat
pppoa
Diplays PPPoA status
liststat pppoe
Diplays PPPoE status
ppptrace
[on | off ]
Enables
or Disables PPP console messages. Requires an RS-232 cable connection
and a running terminal emulation program to view messages (refer to
the Menu User Interface for further instructions).
1483mer
add port vpi vci encapsulation
Configures
the specified WAN interface to use 1483MER (MAC Encapsulation Routing).
The “mer” command is used to enable the configuration.
Port
The MER interface name (mer0).
<vpi>
<vci > These are the vpi, vci values on which the 1483 is
configured. vpi,vci are assigned with the vcadd command. The
showatmconn command can also be used to list the current ATM
connections with their respective vpi and vci values. (Note the vcadd
and showatmconn commands are located in the “atm” directory).
The vpi value is between 0 - 255. The vci value is between 0 - 65535.
-encapsulation
llc | vc Specifies the encapsulation type. The possible values are
‘llc’ or ‘vc’ which represent Logical Link Control or VC multiplexing
respectively.
mer
enable | disable | Delete | Status
Enables,
disables, deletes or gives status of the 1483MER configurations.
relay
relay
-o -client <-if interface> <-pvc vpi vci>
relay
-o -server <-if interface> <-pvc vpi vci>
relay
-o enable | disable
relay
-o -display
Configures
and enables PPPoE relay.
-client
<-if interface> <-pvc vpi vci>
Specifies
the server interface for the PPPoE Relay. The PPPoE server is connected
to this
interface.
The interface may be ppp0, ppp1, ppp2, ppp3,
ppp4, ppp5, ppp6, or ppp7.
-server
<-if interface> <-pvc vpi vci>
Specifies
the client interface for the PPPoE Relay. The PPPoE clients are connected
to this interface. Typically eth0 is specified.
enable
Enables
the PPPoE Relay feature.
disable
Disables
the PPPoE Relay feature.
-display
Displays
the PPPoE Relay configuration.
===============================================================